Outline VBX

Events	Legal Notice	Methods	Properties

Overview

The outline control is a custom control for Microsoft Windows 3.x.  Outline can be used with any Windows development language that is capable of calling functions from a Visual Basic Extenstion (VBX). The outline control can be used as a numerically numbered outline or with numbering and indenting turned off can be used as a editable listbox.

The outline control is unlike most other outline controls available in that it is not intended to be a tree control.  It should be used as either an editable listbox or an outline (ex 1.1, 1.2).

This is a demo version and is not licensed for use in an application. A version of the outline control is available for use in applications (without the nag screen) for $75 (US funds only). Complete source code is also available.

Support

Please send any questions or comments to CIS: 73611, 1023.

Send payment to:

Todd J. Abel

2585 Cooley Road

Canandaigua, New York 14425-9728


AddNode Event

AddNode (Event)

Description:	This event is fired after a node has been added to the control.

Syntax:	Sub ctlname_AddNode(Offset As Integer)

Remarks:	After a node has been added to the control, this event is fired. Offset is the zero based position of the newly added node.

See also:

ChangeNode, DeleteNode, InsertNode


ChangeNode Event

ChangeNode (Event)

Description:	This event is fired after a node within the control has been changed.

Syntax:	Sub ctlname_ChangeNode(Offset As Integer)

Remarks:	After a node has been changed, this event is fired. This event is fired every time the user types within a node. Offset is the zero based position of the changed node.

See also:

AddNode, DeleteNode, InsertNode


ChangeSelection Event

ChangeSelection (Event)

Description:	This event is fired after the user changes the currently selected node.

Syntax:	Sub ctlname_ChangeSelection(Offset As Integer)

Remarks:	After the user changes the currently selected node this event is fired. The selection can be changed by a mouse click or the keyboard. Offset is the zero based position of the selected node.


DeleteNode Event

DeleteNode (Event)

Description:	This event is fired after a node has been deleted from the control.

Syntax:	Sub ctlname_DeleteNode(Offset As Integer)

Remarks:	After a node has been deleted from the control, this event is fired. Offset is the zero based position of the deleted node.

See also:

AddNode, ChangeNode, InsertNode


IndentNode Event

IndentNode (Event)

Description:	This event is fired after a node has been indented.

Syntax:	Sub ctlname_IndentNode(Offset As Integer)

Remarks:	After a node has been indented, this event is fired. Offset is the zero based position of the effected node.


InsertNode Event

InsertNode (Event)

Description:	This event is fired after a node has been inserted.

Syntax:	Sub ctlname_InsertNode(Offset As Integer)

Remarks:	After a node has been inserted, this event is fired. Offset is the zero based position of the newly inserted node.

See also:

AddNode, ChangeNode, DeleteNode


KillFocus Event

KillFocus (Event)

Description:	This event is fired after the outline control has lost the input focus.

Syntax:	Sub ctlname_KillFocus()

Remarks:	None.

See also:

SetFocus


LeftButtonClick Event

LeftButtonClick (Event)

Description:	This event is fired after the user clicks the left mouse button within the control.

Syntax:	Sub ctlname_LeftButtonClick()

Remarks:	None.

See also:

MiddleButtonClick, RightButtonClick


LeftButtonDoubleClick Event

LeftButtonDoubleClick (Event)

Description:	This event is fired after the user double clicks the left mouse button within the control.

Syntax:	Sub ctlname_LeftButtonDoubleClick(Offset As Integer)

Remarks:	After a node has been double clicked on, this event is fired. Offset is the zero based position of the effected node.

See also:

MiddleButtonDoubleClick, RightButtonDoubleClick


MiddleButtonClick

MiddleButtonClick (Event)

Description:	This event is fired after the user clicks the middle mouse button within the control.

Syntax:	Sub ctlname_MiddleButtonClick()

Remarks:	None.

See also:

LeftButtonClick, RightButtonClick


MiddleButtonDoubleClick Event

 MiddleButtonDoubleClick (Event)

Description:	This event is fired after the user double clicks the middle mouse button within the control.

Syntax:	Sub ctlname_MiddleButtonDoubleClick(Offset As Integer)

Remarks:	After a node has been double clicked on, this event is fired. Offset is the zero based position of the effected node.

See also:

LeftButtonDoubleClick, RightButtonDoubleClick


RightButtonClick Event

RightButtonClick (Event)

Description:	This event is fired after the user clicks the right mouse button within the control.

Syntax:	Sub ctlname_RightButtonClick()

Remarks:	None.

See also:

LeftButtonClick, MiddleButtonClick


RightButtonDoubleClick Event

RightButtonDoubleClick (Event)

Description:	This event is fired after the user double clicks the right mouse button within the control.

Syntax:	Sub ctlname_RightButtonDoubleClick(Offset As Integer)

Remarks:	After a node has been double clicked on, this event is fired. Offset is the zero based position of the effected node.

See also:

LeftButtonDoubleClick, MiddleButtonDoubleClick


SetFocus Event

SetFocus (Event)

Description:	This event is fired after the outline control has gained the input focus.

Syntax:	Sub ctlname_SetFocus()

Remarks:	None.

See also:

KillFocus


VerticalScroll Event

VerticalScroll (Event)

Description:	This event is fired after the user scrolls the outline control.

Syntax:	Sub ctlname_VerticalScroll()

Remarks:	None.


Events

AddNode	InsertNode	MiddleButtonDoubleClick
ChangeNode	KillFocus	RightButtonClick
ChangeSelection	LeftButtonClick	RightButtonDoubleClick
DeleteNode	LeftButtonDoubleClick	SetFocus
IndentNode	MiddleButtonClick	VerticalScroll


Properties

About	AllowAppend	AllowDelete
AllowEdit	AllowInsert	BackColor
Bitmap	BitmapCount	Bitmaps
BorderStyle	Count	CtlName
Enabled	FontBold	FontItalic
FontName	FontSize	FontStrikeThru
Height	Hidden	Indent
Index	Left	List
ListCount	ListIndex	MaximumIndent
Numbering	NumVisible	Parent
Position	Redraw	SelLength
SelStart	SelText	ShowBitmaps
TabIndex	TabStop	Tag
Text	Top	Visible
Width


Methods

AddItem	RemoveItem	Refresh


Example


About Property

About (Dialog)

Description: 	Displays a dialog box that contains the version number of OL_VBX.VBX.

Usage:	Used only from within the Visual Basic environment

Remarks:	To display the About dialog, click on the ellipsis (...) that appears in the properties list. This is a design time only property.


AllowEdit Property

AllowEdit (Boolean)

Description:	Sets or returns TRUE or FALSE if the user is allowed to edit nodes within the outline.

Usage:	[FORM.]ctlname.AllowEdit = boolean%

Remarks:	The default setting is TRUE. Valid settings are:

Setting	Description

TRUE	The user is allowed to edit nodes within the outline.

FALSE	The user is not allowed to edit nodes within the outline.

See also:

AllowAppend, AllowDelete, AllowInsert


AllowDelete Property

AllowDelete (Boolean)

Description:	Sets or returns TRUE or FALSE if the user is allowed to delete nodes within the outline.

Usage:	[FORM.]ctlname.AllowDelete = boolean%

Remarks:	The default setting is TRUE. Valid settings are:

Setting	Description

TRUE	The user is allowed to delete nodes within the outline.

FALSE	The user is not allowed to delete nodes within the outline.

See also:

AllowAppend, AllowEdit, AllowInsert


AllowAppend Property

AllowAppend (Boolean)

Description:	Sets or returns TRUE or FALSE if the user is allowed to append new nodes to the end of the outline.

Usage:	[FORM.]ctlname.AllowAppend = boolean%

Remarks:	The default setting is TRUE. Valid settings are:

Setting	Description

TRUE	The user is allowed to append new nodes to the outline.

FALSE	The user is not allowed to append new node to the outline.

See also:

AllowDelete, AllowEdit, AllowInsert


AllowInsert Property

AllowInsert (Boolean)

Description:	Sets or returns TRUE or FALSE if the user is allowed to insert nodes within the outline.

Usage:	[FORM.]ctlname.AllowInsert = boolean%

Remarks:	The default setting is TRUE. Valid settings are:

Setting	Description

TRUE	The user is allowed to insert nodes within the outline.

FALSE	The user is not allowed to insert nodes within the outline.

See also:

AllowAppend, AllowDelete, AllowEdit


Bitmap Property

Bitmap (integer)

Description:	Sets or returns the bitmap for the current node.

Usage:	[FORM.]ctlname.Bitmap = integer%

Remarks:	The integer is the index of the bitmap in the Bitmaps array. If the bitmaps is not set or invalid, no bitmaps will be shown.

See also:

BitmapsCount, Bitmaps, ShowBitmaps


BitmapCount Property

BitmapCount (integer)

Description:	Returns the number of bitmaps loaded.

Usage:	integer% = [FORM.]ctlname.BitmapCount

Remarks:	This property is read only.

See also:

Bitmap, Bitmaps, ShowBitmaps


Bitmaps Property

Bitmaps (integer)

Description:	An integer array containing a number of .Picture properties (hPics of pictures). Images can be loaded into this array before being displayed in the control.

Usage:	[FORM.]ctlname.Bitmaps(element%) = LoadPicture(bmp.bmp)

Remarks:	The element% is the index of the bitmap in the Bitmaps array.

See also:

Bitmap, BitmapCount, ShowBitmaps


Count Property

Count (Integer)

Description:	Returns the number of nodes within the outline.

Usage:	Integer% = [FORM.]ctlname.Count

Remarks:	None


Hidden Property

Hidden (Boolean)

Description:	Returns the visilibity of the current node. If a node has subnodes, and the node is hiddent then all of the subnodes are also hidden also.

Usage:	[FORM.]ctlname.Hidden = boolean%

Remarks:	The default setting is FALSE. Valid settings are:

Setting	Description

TRUE	The node and all subnodes are hidden from the user.

FALSE	The node is visible to the user.


Indent Property

Indent (Integer)

Description:	Sets or returns the current indent level of the current node.

Usage:	[FORM.]ctlname.Indent = integer%

Remarks:	The default setting is 0. The range is between 0 and 7. When setting a nodes indent level, the indent level should not be set to more than the outlines current maximum level. The indent level can not be set to more than the value in MaximumIndent.

See also:

MaximumIndent


MaximumIndent Property

MaximumIndent (Integer)

Description:	Sets or returns the maximum indent level of outline control.

Usage:	[FORM.]ctlname.MaximumIndent = integer%

Remarks:	The default setting is 7. The range is between 0 and 7. When setting a nodes indent level.  The maximum indent level is checked only when the user is changing the indent level.

See also:

Indent


Numbering Property

Numbering (Integer)

Description:	Sets or returns the current numbering style.

Usage:	[FORM.]ctlname.Numbering = integer%

Remarks:	The default setting is 1 (numeric). This controls the numbering style that appears to the left of each node.  Valid settings are:

Setting	Description

0	No numbering. No numbering is displayed.

1	Numeric numbering. Nodes will automatically be numbered consecutively, 1, 2, 3, 4. If a node is indented, it takes on the parents number plus a consecutive number 1.1, 1.2, 1.3, 1.4.


Position Property

Position (Integer)

Description:	Sets or returns the current node within the outline control.

Usage:	[FORM.]ctlname.Position = integer%

Remarks:	Position is zero based. The current position can not be set to less than zero or greater than the number of nodes within the outline control.


Redraw Property

Redraw (Boolean)

Description:	Sets or returns TRUE or FALSE if the outline control will be redrawn.

Usage:	[FORM.]ctlname.Redraw = boolean%

Remarks:	The default setting is TRUE. This setting is useful if many changes are being made to the outline control. Set Redraw to FALSE, make the changes and then set Redraw to TRUE. Valid settings are:

Setting	Description

TRUE	Redrawing occurs normally.

FALSE	No redrawing occurs.


ShowBitmaps Property

ShowBitmaps (Boolean)

Description:	Sets or returns TRUE or FALSE if the outline control show bitmaps.

Usage:	[FORM.]ctlname.ShowBitmaps = boolean%

Remarks:	The default setting is FALSE.. Valid settings are:

Setting	Description

TRUE	Node bitmaps are show.

FALSE	Node bitmaps are not shown.

See also:

Bitmap, BitmapCount, Bitmaps


Legal Notices

The Software is protected by the copyright laws that pertain to computer software. Federal copyright law permits you to make one backup copy of the Software, except the OL_RUN.VBX explicitly designated as "redistributable", by any means, in whole or part, for other purposes.

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means without prior written consent of Todd J. Abel with the exception of the key commands table. Information in this manual is subject to change without notice and does not represent a commitment on the part of the vendor.

No other warranties, express or implied, by statute or otherwise, regarding the use of, or the results of the use of this software and the related materials in terms of correctness, accuracy, reliability, currentness, or otherwise. In no event will the vendor be liable for any special, consequential, or other damages for breach of warrant.

The following trademarks are used throughout this help system. Whenever you come across them, please remember that they are the trademarks or registered trademarks of the companies shown below.

Microsoft is a registered trademark and Window and Visual Basic are trademarks of Microsoft Corporation.

All other names are trademarks or register trademarks of their respective owners.


NumVisible Property

ShowBitmaps (Integer)

Description:	Returns the number of visible nodes in the outline control.

Usage:	integer% = [FORM.]ctlname.NumVisible

Remarks:	None.